-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Versioning Documentation #1388
Conversation
This looks great. I appreciate that you're versioning packages in place to avoid breaking existing beta users when a package becomes stable, and that you've found a balance between a generic cross-language versioning scheme with Go's more stringent requirements. One request: contrib isn't mentioned here, but it would be good to clarify versioning for contrib packages as well, including the requirement that contrib packages must be kept up to date with the latest release of core. |
@tedsuo I added a section for the contrib project. PTAL |
@MrAlias Excellent writeup. +1 on the distinction between stable and other versions.
@rakyll would love to get your comments. |
Backwards compatibility is guaranteed by the major version number as specified by semver 2.0
This means modules released with the same major version number will remain backwards compatible.
Any type of patching of a bug (e.g. security, performance, correctness) will result in a patch version increment as specified by semver 2.0
|
@MrAlias This is really, really, really excellent. 💯 |
Co-authored-by: Joshua MacDonald <jmacd@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great. I left some more comments on the earlier doc on some edge cases but the versioning scheme here looks good.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo. Otherwise looks good.
Co-authored-by: Krzesimir Nowak <qdlacz@gmail.com>
Include a versioning policy that describes this projects system of versioning principles stability guarantees.
Addresses open-telemetry/opentelemetry-specification#1267